Content
Resources are created, modified, deleted, and queried in order to be uploaded and managed on the Publica.la platform. These resources can be ebooks in PDF or EPUB formats, as well as audiobooks in MP3 format, and physical books.
Base URL
All following endpoints operates over the URL of your store: https://your-store.com/
example: https://alephdigital.publica.la/
Endpoints |
---|
upload |
get |
update |
delete |
Headers
{
"Content-Type": "application/json",
"Accept": "application/json",
"X-User-Token": {api_token}
}
info
Make sure you generated the api_token on your store. More info HERE
Upload
POST /integration-api/v1/dashboard/issues
Example: https://your-store.com/integration-api/v1/dashboard/issues
Body Request for digital content
Field | Description | Required | Type | Format |
---|---|---|---|---|
publication_date | Date of publication | yes | string, date | YYYY-MM-DD e.g. '2018-07-27' |
name | Title of the publication | yes | string | |
description | Description of the publication | no | string | |
extension | File extension of the content (e.g., 'mpga', 'mp3', 'pdf', 'epub') | yes | string | 'mpga', 'mp3', 'pdf' or 'epub' |
file_url | URL of the content. It can be a public URL, or a signed URL. | yes | string | |
external_id | Reference code used internally for organizational purposes. Must be unique. | yes | string | |
free | If the content is freely accessible. | no | boolean | |
bisac | Bisac Code used as genre for of the title. ie: ["FIC029000", "DES002000", "FAM000000"] | no | list of objects | You may find all available values at BISG Website |
collection | The existing collection(s) to which the resource belongs." | no | list of strings | |
author | Name(s) of the author(s) of the content | no | list of strings | |
country | Country or countries where the content is available | no | list of strings | |
category | Category or categories that can be assigned to the content. | no | list of strings | |
publisher | Publisher(s) of the content | no | list of strings | |
keyword | Keywords for search. | no | list of strings | |
prices | Content prices according to payment currency. | no | object | Supported values: USD,ARS,EUR,MXN,COP,PEN,CLP,AUD,UYU,BOB,PYG,BRL,INR,GTQ,HNL. |
lang | language. | no | object | You may find all available values at ISO 639-1 |
table_of_contents | The publication's table of contents. | no | json |
JSON example for pdf content:
{
"publication_date": "2020-06-01",
"name": "The Computing Machine",
"description": "The description of the publication...",
"free": 0,
"bisac": [{ "code": "ANT018000" }],
"extension": "pdf",
"file_url": "https://valid/url/for.pdf",
"collection": ["The classics"],
"author": ["Grace Hopper"],
"country": ["Finland"],
"category": ["Hardware meets software"],
"publisher": ["publica.la"],
"keyword": ["API", "book"],
"prices": {
"USD": 2.00,
"ARS": 0.02,
"EUR": 2.35,
"MXN": 0.10,
"COP": 0.00,
"PEN": 0.51,
"CLP": 0.00,
"AUD": 1.47,
"UYU": 0.05,
"BOB": 0.29,
"PYG": 0.00,
"BRL": 0.38,
"INR": 0.03,
"GTQ": 0.26,
"HNL": 0.08
}
}
JSON example for epub content:
{
"description": "This book is an essential guide for those who wish to understand the mechanisms behind our actions and how we can harness the power of habits.",
"external_id": "isbn112233441",
"lang": "en",
"name": "The Power of Habits",
"type": "epub",
"author": ["Grace Hopper"],
"published_at": "2022-09-01 12:00:00",
"bisac": [{ "code": "SEL009000" }],
"extension":"epub",
"file_url": "https://valid/url/for.epub",
"publisher": ["publica.la"],
"keyword": ["API", "book"],
"prices": {
"USD": 2.00,
"ARS": 0.02,
"EUR": 2.35,
"MXN": 0.10,
"COP": 0.00,
"PEN": 0.51,
"CLP": 0.00,
"AUD": 1.47,
"UYU": 0.05,
"BOB": 0.29,
"PYG": 0.00,
"BRL": 0.38,
"INR": 0.03,
"GTQ": 0.26,
"HNL": 0.08
}
}
JSON example for mp3 content
{
"description": "O Trabalho com o Espelho, um dos ensinamentos centrais de Louise Hay, sustenta que nossa experi\u00eancia de vida espelha nosso relacionamento com n\u00f3s mesmos; a menos que nos vejamos como dignos de sermos amados, o mundo pode ser um lugar escuro e solit\u00e1rio. O trabalho com o espelho - olhando para si mesmo em um espelho e repetindo afirma\u00e7\u00f5es positivas - \u00e9 um m\u00e9todo poderoso de Louise Hay para aprender a amar a si mesmo e experimentar o mundo como um lugar seguro e acolhedor. Em 21 Dias para curar a sua vida \u2013 Aprenda a se amar trabalhando com o espelho, apresenta um programa de ensinamento e exerc\u00edcios para ajudar o leitor a aprofundar seu relacionamento consigo mesmo e a viver uma vida feliz e gratificante. \r\n\r\nCada um dos 21 dias \u00e9 organizado em torno de um tema, como monitorar o autocontrole, superar o medo, liberar a raiva, curar relacionamentos, perdoar a si mesmo e aos outros, receber prosperidade e viver sem estresse. O programa envolve um exerc\u00edcio em frente ao espelho, afirma\u00e7\u00f5es, registro em um di\u00e1rio, uma mensagem de amor para refletir e uma medita\u00e7\u00e3o guiada.\r\n\r\nRepleto de orienta\u00e7\u00f5es pr\u00e1ticas, escrito da maneira calorosamente pessoal de Louise, Trabalhando com o Espelho, como ela gosta de lhe chamar, foi criado para ajudar os leitores a:\r\n\r\n\u2022Aprender um n\u00edvel mais profundo de autocuidado\r\n\u2022Ganhar confian\u00e7a em seu pr\u00f3prio sistema de orienta\u00e7\u00e3o interna\r\n\u2022Desenvolver a consci\u00eancia de seus dons da alma\r\n\u2022Superar a resist\u00eancia \u00e0 mudan\u00e7a\r\n\u2022Aumentar a autoestima\r\n\u2022Cultivar o amor e a compaix\u00e3o nas suas rela\u00e7\u00f5es consigo pr\u00f3prio e com os outros\r\n\r\nEm apenas tr\u00eas semanas, o leitor pode estabelecer firmemente o Trabalho com o Espelho como uma pr\u00e1tica cont\u00ednua para o crescimento positivo e um caminho para uma vida plena e rica.\r\n\r\n\"Fazer o trabalho com o espelho\", diz Louise, \"\u00e9 um dos presentes mais amorosos que voc\u00ea pode se dar.\"",
"external_id": "696900",
"lang": "pt",
"name": "test audio api",
"type": "mp3",
"publication_date": "2019-09-13",
"extension":"mp3",
"file_url": "https://filesamples.com/samples/audio/mp3/Symphony%20No.6%20(1st%20movement).mp3"
}
Body Request for physical content
Field | Description | Required | Type | Format |
---|---|---|---|---|
publication_date | Date of publication | yes | string, date | YYYY-MM-DD e.g. '2018-07-27' |
name | Title of the publication | yes | string | |
description | Description of the publication | no | string | |
external_id | Reference code used internally for organizational purposes. Must be unique. | yes | string | |
free | If the content is freely accessible. | no | boolean | |
bisac | Bisac Code used as genre for of the title. ie: ["FIC029000", "DES002000", "FAM000000"] | no | list of objects | You may find all available values at BISG Website |
collection | The existing collection(s) to which the resource belongs." | no | list of strings | |
author | Name(s) of the author(s) of the content | no | list of strings | |
country | Country or countries where the content is available | no | list of strings | |
category | Category or categories that can be assigned to the content. | no | list of strings | |
publisher | Publisher(s) of the content | no | list of strings | |
keyword | Keywords for search. | no | list of strings | |
prices | Content prices according to payment currency. | no | object | Supported values: USD,ARS,EUR,MXN,COP,PEN,CLP,AUD,UYU,BOB,PYG,BRL,INR,GTQ,HNL. |
lang | language. | no | object | You may find all available values at ISO 639-1 |
type | type of content. | yes | string | 'physical' |
table_of_contents | The publication's table of contents. | no | html | |
pages | Quantity of pages | no | integer | |
height | This field indicates the vertical dimension of the physical content in specific units (e.g., centimeters or inches). | no | integer | |
width | This field indicates the horizontal dimension of the physical product in specific units (e.g., centimeters or inches). | no | integer | |
weight | This field indicates the vertical dimension of the physical product in specific units (e.g., centimeters or inches). | no | integer | |
stock | Quantity available for sale. | no | integer |
JSON example for physical content
{
"description": "En las sombrías calles de un pequeño pueblo olvidado, una serie de desapariciones inexplicables comienza a sembrar el terror entre sus habitantes. Ana, una joven periodista con un pasado oscuro, regresa a su ciudad natal para investigar los misteriosos sucesos. A medida que se sumerge en la investigación, descubre antiguas leyendas y secretos ocultos que conectan las desapariciones con un mal ancestral que ha estado acechando en las sombras durante siglos. Con cada página que pasa, la tensión aumenta y las líneas entre la realidad y la pesadilla se desdibujan. Ana deberá enfrentarse a sus propios miedos más profundos para desentrañar la verdad antes de que sea demasiado tarde. Este relato te sumergirá en un viaje escalofriante donde cada giro de página te dejará sin aliento, cuestionando lo que es real y lo que es producto de una mente perturbada. ¿Te atreves a descubrir el oscuro secreto que yace entre las páginas de este libro?",
"external_id": "999333222",
"lang": "es",
"name": "test physical api",
"type": "physical",
"publication_date": "2024-09-13",
"binding_type": "Japonesa",
"editing_location": "Japan",
"table_of_contents": "<tabla de contenido>",
"pages" : 256,
"height" : 34,
"width" : 40,
"weight" : 290,
"stock" : 1
}
Responses
Field | Description | Type |
---|---|---|
CODE | The status code of the response | string |
data.issue.lang | The language of the resource | string |
data.issue.name | The name of the resource | string |
data.issue.external_id | The external ID of the resource | string |
data.issue.published_at | The publication date of the resource | object |
data.issue.notification_text | The notification text of the resource | string |
data.issue.audience | The audience of the resource | string |
data.issue.version | The version of the resource | integer |
data.issue.user_id | The user ID of the resource | integer |
data.issue.slug | The unique identifier of the resource | string |
data.issue.bucket_domain | The storage domain of the resource | string |
data.issue.conversion_status | The conversion status of the resource | string |
data.issue.id | The ID of the resource | integer |
data.issue.description | The description of the resource | string |
data.issue.is_owned_by_current_tenant | Indicates whether the resource is owned by the current tenant | boolean |
data.issue.free | Indicates whether the resource is free | boolean |
data.issue.prices | The prices of the resource according to the payment currency | object |
data.issue.file | Information about the file of the resource | object |
data.issue.description_raw_text | The raw text description of the resource | string |
data.issue.description_with_html | The HTML-formatted description of the resource | string |
data.issue.require_login | Indicates if login is required to access the resource | boolean |
data.issue.require_login_for_preview | Indicates if login is required to preview the resource | boolean |
data.issue.conversion_status_progress | The progress of the resource's conversion status | string |
data.issue.published_at_utc | The publication date of the resource in UTC format | string |
data.issue.issue_description.issue_id | The ID of the resource | integer |
data.issue.issue_description.description | The description of the resource | string |
data.issue.price_morph | Information about alternate prices of the resource | object |
data.issue.file.tenant_id | The ID of the file's tenant | integer |
data.issue.file.issue_id | The ID of the resource | integer |
data.issue.file.id | The ID of the file of the resource | integer |
data.issue.file.version | The version of the file of the resource | integer |
data.issue.file.track_title | The track title of the file of the resource | string |
data.issue.file.duration | The duration of the file of the resource (in seconds) | integer |
data.issue.file.order | The order of the file of the resource | integer |
data.issue.file.size_in_kb | The size of the file of the resource (in kilobytes) | integer |
data.message | The message associated with the response | string |
JSON example
{
"CODE": "success",
"data": {
"issue": {
"lang": "pt",
"name": "test audio api",
"external_id": "696900",
"published_at": {
"timestamp": 1568343600,
"date": "2019-09-13 00:00:00",
"timezone": "America/Argentina/Buenos_Aires"
},
"notifies_users": 0,
"notification_text": null,
"medusa_automation_id": null,
"medusa_automation_status": null,
"audience": null,
"version": 1,
"user_id": 1,
"slug": "test-audio-api-1712991786",
"bucket_domain": "storage-dev-local.farfalla.localhost",
"conversion_status": "started_dispatching_conversion",
"conversion_settings": {
"PdfConversionQuality": "high",
"PdfSplitInPages": {
"pagesPerGroup": null,
"concurrentWorkerRequests": null
},
"PdfProcessPages": {
"pagesPerGroup": null,
"concurrentWorkerRequests": 16
}
},
"id": 1000003,
"description": "O Trabalho com o Espelho, um dos ensinamentos centrais de Louise Hay, sustenta que nossa experiência de vida espelha nosso relacionamento com nós mesmos; a menos que nos vejamos como dignos de sermos amados, o mundo pode ser um lugar escuro e solitário. O trabalho com o espelho - olhando para si mesmo em um espelho e repetindo afirmações positivas - é um método poderoso de Louise Hay para aprender a amar a si mesmo e experimentar o mundo como um lugar seguro e acolhedor. Em 21 Dias para curar a sua vida – Aprenda a se amar trabalhando com o espelho, apresenta um programa de ensinamento e exercícios para ajudar o leitor a aprofundar seu relacionamento consigo mesmo e a viver uma vida feliz e gratificante. \r\n\r\nCada um dos 21 dias é organizado em torno de um tema, como monitorar o autocontrole, superar o medo, liberar a raiva, curar relacionamentos, perdoar a si mesmo e aos outros, receber prosperidade e viver sem estresse. O programa envolve um exercício em frente ao espelho, afirmações, registro em um diário, uma mensagem de amor para refletir e uma meditação guiada.\r\n\r\nRepleto de orientações práticas, escrito da maneira calorosamente pessoal de Louise, Trabalhando com o Espelho, como ela gosta de lhe chamar, foi criado para ajudar os leitores a:\r\n\r\n•Aprender um nível mais profundo de autocuidado\r\n•Ganhar confiança em seu próprio sistema de orientação interna\r\n•Desenvolver a consciência de seus dons da alma\r\n•Superar a resistência à mudança\r\n•Aumentar a autoestima\r\n•Cultivar o amor e a compaixão nas suas relações consigo próprio e com os outros\r\n\r\nEm apenas três semanas, o leitor pode estabelecer firmemente o Trabalho com o Espelho como uma prática contínua para o crescimento positivo e um caminho para uma vida plena e rica.\r\n\r\n\"Fazer o trabalho com o espelho\", diz Louise, \"é um dos presentes mais amorosos que você pode se dar.\"",
"description_raw_text": "O Trabalho com o Espelho, um dos ensinamentos centrais de Louise Hay, sustenta que nossa experiência de vida espelha nosso relacionamento com nós mesmos; a menos que nos vejamos como dignos de sermos amados, o mundo pode ser um lugar escuro e solitário. O trabalho com o espelho - olhando para si mesmo em um espelho e repetindo afirmações positivas - é um método poderoso de Louise Hay para aprender a amar a si mesmo e experimentar o mundo como um lugar seguro e acolhedor. Em 21 Dias para curar a sua vida – Aprenda a se amar trabalhando com o espelho, apresenta um programa de ensinamento e exercícios para ajudar o leitor a aprofundar seu relacionamento consigo mesmo e a viver uma vida feliz e gratificante. Cada um dos 21 dias é organizado em torno de um tema, como monitorar o autocontrole, superar o medo, liberar a raiva, curar relacionamentos, perdoar a si mesmo e aos outros, receber prosperidade e viver sem estresse. O programa envolve um exercício em frente ao espelho, afirmações, registro em um diário, uma mensagem de amor para refletir e uma meditação guiada.Repleto de orientações práticas, escrito da maneira calorosamente pessoal de Louise, Trabalhando com o Espelho, como ela gosta de lhe chamar, foi criado para ajudar os leitores a:•Aprender um nível mais profundo de autocuidado•Ganhar confiança em seu próprio sistema de orientação interna•Desenvolver a consciência de seus dons da alma•Superar a resistência à mudança•Aumentar a autoestima•Cultivar o amor e a compaixão nas suas relações consigo próprio e com os outrosEm apenas três semanas, o leitor pode estabelecer firmemente o Trabalho com o Espelho como uma prática contínua para o crescimento positivo e um caminho para uma vida plena e rica.\"Fazer o trabalho com o espelho\", diz Louise, \"é um dos presentes mais amorosos que você pode se dar.\"",
"description_with_html": "O Trabalho com o Espelho, um dos ensinamentos centrais de Louise Hay, sustenta que nossa experiência de vida espelha nosso relacionamento com nós mesmos; a menos que nos vejamos como dignos de sermos amados, o mundo pode ser um lugar escuro e solitário. O trabalho com o espelho - olhando para si mesmo em um espelho e repetindo afirmações positivas - é um método poderoso de Louise Hay para aprender a amar a si mesmo e experimentar o mundo como um lugar seguro e acolhedor. Em 21 Dias para curar a sua vida – Aprenda a se amar trabalhando com o espelho, apresenta um programa de ensinamento e exercícios para ajudar o leitor a aprofundar seu relacionamento consigo mesmo e a viver uma vida feliz e gratificante. <br />\r\n<br />\r\nCada um dos 21 dias é organizado em torno de um tema, como monitorar o autocontrole, superar o medo, liberar a raiva, curar relacionamentos, perdoar a si mesmo e aos outros, receber prosperidade e viver sem estresse. O programa envolve um exercício em frente ao espelho, afirmações, registro em um diário, uma mensagem de amor para refletir e uma meditação guiada.<br />\r\n<br />\r\nRepleto de orientações práticas, escrito da maneira calorosamente pessoal de Louise, Trabalhando com o Espelho, como ela gosta de lhe chamar, foi criado para ajudar os leitores a:<br />\r\n<br />\r\n•Aprender um nível mais profundo de autocuidado<br />\r\n•Ganhar confiança em seu próprio sistema de orientação interna<br />\r\n•Desenvolver a consciência de seus dons da alma<br />\r\n•Superar a resistência à mudança<br />\r\n•Aumentar a autoestima<br />\r\n•Cultivar o amor e a compaixão nas suas relações consigo próprio e com os outros<br />\r\n<br />\r\nEm apenas três semanas, o leitor pode estabelecer firmemente o Trabalho com o Espelho como uma prática contínua para o crescimento positivo e um caminho para uma vida plena e rica.<br />\r\n<br />\r\n\"Fazer o trabalho com o espelho\", diz Louise, \"é um dos presentes mais amorosos que você pode se dar.\"",
"is_owned_by_current_tenant": true,
"free": false,
"free_to": null,
"prices": [],
"preview": null,
"private_material": null,
"publication_date": {
"timestamp": 1568343600,
"date": "2019-09-13 00:00:00",
"timezone": "America/Argentina/Buenos_Aires"
},
"require_login": null,
"require_login_for_preview": null,
"conversion_status_progress": "Starting conversion process 3/4",
"published_at_utc": "2019-09-13 03:00:00",
"issue_description": {
"issue_id": 1000003,
"description": "O Trabalho com o Espelho, um dos ensinamentos centrais de Louise Hay, sustenta que nossa experiência de vida espelha nosso relacionamento com nós mesmos; a menos que nos vejamos como dignos de sermos amados, o mundo pode ser um lugar escuro e solitário. O trabalho com o espelho - olhando para si mesmo em um espelho e repetindo afirmações positivas - é um método poderoso de Louise Hay para aprender a amar a si mesmo e experimentar o mundo como um lugar seguro e acolhedor. Em 21 Dias para curar a sua vida – Aprenda a se amar trabalhando com o espelho, apresenta um programa de ensinamento e exercícios para ajudar o leitor a aprofundar seu relacionamento consigo mesmo e a viver uma vida feliz e gratificante. \r\n\r\nCada um dos 21 dias é organizado em torno de um tema, como monitorar o autocontrole, superar o medo, liberar a raiva, curar relacionamentos, perdoar a si mesmo e aos outros, receber prosperidade e viver sem estresse. O programa envolve um exercício em frente ao espelho, afirmações, registro em um diário, uma mensagem de amor para refletir e uma meditação guiada.\r\n\r\nRepleto de orientações práticas, escrito da maneira calorosamente pessoal de Louise, Trabalhando com o Espelho, como ela gosta de lhe chamar, foi criado para ajudar os leitores a:\r\n\r\n•Aprender um nível mais profundo de autocuidado\r\n•Ganhar confiança em seu próprio sistema de orientação interna\r\n•Desenvolver a consciência de seus dons da alma\r\n•Superar a resistência à mudança\r\n•Aumentar a autoestima\r\n•Cultivar o amor e a compaixão nas suas relações consigo próprio e com os outros\r\n\r\nEm apenas três semanas, o leitor pode estabelecer firmemente o Trabalho com o Espelho como uma prática contínua para o crescimento positivo e um caminho para uma vida plena e rica.\r\n\r\n\"Fazer o trabalho com o espelho\", diz Louise, \"é um dos presentes mais amorosos que você pode se dar.\""
},
"price_morph": [],
"file": {
"tenant_id": 1,
"issue_id": 1000003,
"id": 1,
"version": 1,
"track_title": "test audio api",
"duration": 728,
"order": 0,
"size_in_kb": 11650
}
},
"message": "The title will be processed and available in your library in a moment.."
}
}
Code | Description |
---|---|
201 | Object Created |
422 | Validation error, the reason of the error will be described in the response body |
401 | Unauthenticated |
(*) You can host your files in Google Drive and use the URL where it is hosted. You must convert that URL to be a direct link to download the file, for that you can use this Google tool to get the URL that you can then use in the file_url. Once the file is uploaded, remember to change the permissions or delete it from your Google Drive for safety.
Get
GET /integration-api/v1/dashboard/issues/{id || external_reference}?query=
Using this endpoint you can either paginate through all the resources, search for publications by different parameters, or get a specific external_id or id In this case we will obtain all the existing publications in the store.
tip
Using query parameter you can filter by converting
or deferred
, name, external_id and id
examples:
Getting specific resources that are in a converting state.
https://your-store.com/integration-api/v1/dashboard/issues/?query=converting
Retrieve specific resources that are in a deferred state.
https://your-store.com/integration-api/v1/dashboard/issues/?query=deferred
Getting a specific resource by the name
https://your-store.com/integration-api/v1/dashboard/issues/?query={{name}}
Getting a specific resource by the ID in our system:
https://your-store.com/integration-api/v1/dashboard/issues/?query=468166
orhttps://your-store.com/integration-api/v1/dashboard/issues/468166
Getting all your resources
https://your-store.com/integration-api/v1/dashboard/issues/
Response
Code | Description |
---|---|
200 | Object returned |
404 | Object not found |
401 | Unauthenticated |
Response Example
Example
{
"CODE": "success",
"data": {
"paginator": {
"current_page": 1,
"data": [
{
"id": 468166,
"external_id": "9781496822482",
"version": 1,
"marketplace": 1,
"license": {
"ppu": false,
"retail": true
},
"discount": 50,
"file_type": "epub",
"lang": "en",
"user_id": 47635,
"medusa_automation_id": null,
"name": "Conversations with Donald Hall",
"slug": "conversations-with-donald-hall",
"conversion_status": "done",
"conversion_settings": {
"PdfSplitInPages": {
"pagesPerGroup": null,
"concurrentWorkerRequests": null
}
},
"conversion_details": null,
"published_at": {
"timestamp": 1616122800,
"date": "2021-03-19 00:00:00",
"timezone": "America/Argentina/Buenos_Aires"
},
"bucket_domain": "storage.publica.la",
"cover_image_path": "https://your-store.com/publicala/issues/2021/03/ZotqenpMS797S5wS/41a3c9c7-5f9f-4db5-bb6c-714865d2fdbd_cover.jpg",
"number_of_pages": null,
"notifies_users": null,
"notification_text": null,
"notified_users_at": null,
"medusa_automation_status": null,
"created_at": "2021-03-06 06:00:51",
"ti_id": 531184,
"ti_tenant_id": 627,
"ti_issue_id": 468166,
"ti_license": "retail",
"ti_withdrawn": 0,
"ti_free": 0,
"ti_free_to": null,
"ti_require_login": null,
"ti_preview": 0,
"ti_require_login_for_preview": 0,
"ti_private_material": null,
"ti_published_at": "2021-03-19 03:00:00",
"ti_created_at": "2021-03-24 13:46:37",
"ti_updated_at": "2021-03-24 16:10:15",
"ti_deleted_at": null,
"cover": "https://your-store.com/publicala/issues/2021/03/ZotqenpMS797S5wS/41a3c9c7-5f9f-4db5-bb6c-714865d2fdbd_cover.jpg",
"url": "https://your-store.com/reader/conversations-with-donald-hall",
"share_url": "https://your-store.com/library/publication/conversations-with-donald-hall",
"public_file_url": "https://your-store.com/api/v1/dashboard/issues/468166/temp-public-url",
"current_session_limit": 0,
"can_be_removed_from_inventory": true,
"notes_count": 0,
"description": "<i>Conversations with Donald Hall</i> offers a unique glimp...",
"description_with_html": "<i>Conversations with Donald Hall</i> offers a unique glimp...",
"is_owned_by_current_tenant": true,
"free": false,
"free_to": null,
"prices": {
"USD": 25
},
"preview": true,
"private_material": null,
"publication_date": {
"timestamp": 1616122800,
"date": "2021-03-19 00:00:00",
"timezone": "America/Argentina/Buenos_Aires"
},
"require_login": null,
"require_login_for_preview": 0,
"conversion_status_progress": null,
"published_at_utc": "2021-03-19 03:00:00",
"price_morph": [
{
"tenant_id": 1,
"id": 461064,
"priceable_type": "issue",
"priceable_id": 468166,
"type": "single",
"country_code": null,
"currency_id": "USD",
"amount_in_cents": 2500,
"created_at": "2021-03-06 06:00:52",
"updated_at": "2021-03-06 06:00:52",
"deleted_at": null
}
],
"sessions": null,
"issue_description": {
"issue_id": 468166,
"description": "<i>Conversations with Donald Hall</i> offers a unique glimp..."
}
}
],
"first_page_url": "https://your-store.com/integration-api/v1/dashboard/issues?page=1",
"from": 1,
"last_page": 6,
"last_page_url": "https://your-store.com/integration-api/v1/dashboard/issues?page=6",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://your-store.com/integration-api/v1/dashboard/issues?page=1",
"label": 1,
"active": true
},
{
"url": "https://your-store.com/integration-api/v1/dashboard/issues?page=2",
"label": 2,
"active": false
},
{
"url": "https://your-store.com/integration-api/v1/dashboard/issues?page=3",
"label": 3,
"active": false
},
{
"url": "https://your-store.com/integration-api/v1/dashboard/issues?page=4",
"label": 4,
"active": false
},
{
"url": "https://your-store.com/integration-api/v1/dashboard/issues?page=5",
"label": 5,
"active": false
},
{
"url": "https://your-store.com/integration-api/v1/dashboard/issues?page=6",
"label": 6,
"active": false
},
{
"url": "https://your-store.com/integration-api/v1/dashboard/issues?page=2",
"label": "Next »",
"active": false
}
],
"next_page_url": "https://your-store.com/integration-api/v1/dashboard/issues?page=2",
"path": "https://your-store.com/integration-api/v1/dashboard/issues",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 82
},
"reached_issues_limit": false,
"reached_free_issues_limit": false
}
}
Update
PUT /integration-api/v1/dashboard/issues/{issue_id}
Example : https://your-store.com/integration-api/v1/dashboard/issues/468166
info
The issue_id
can be obtained with the GET method
Parameters
Field | Description | Required | Required for physical | Type | Format |
---|---|---|---|---|---|
publication_date | Date of publication | yes | yes | string, date | YYYY-MM-DD e.g. '2018-07-27' |
name | Title of the publication | yes | yes | string | |
description | Description of the publication | no | no | string | |
extension | File extension of the content (e.g., 'mpga', 'mp3', 'pdf', 'epub') | yes | no | string | 'mpga', 'mp3', 'pdf' or 'epub' |
external_id | Reference code used internally for organizational purposes. Must be unique. | yes | yes | string | |
free | If the content is freely accessible. | no | no | boolean | |
bisac | Bisac Code used as genre for of the title. | no | no | list of objects | You may find all available values at BISG Website |
collection | The existing collection(s) to which the resource belongs." | no | no | list of strings | |
author | Name(s) of the author(s) of the content | no | no | list of strings | |
country | Country or countries where the content is available | no | no | list of strings | |
category | Category or categories that can be assigned to the content. | no | no | list of strings | |
publisher | Publisher(s) of the content | no | no | list of strings | |
keyword | Keywords for search. | no | no | list of strings | |
prices | Content prices according to payment currency. | no | no | object | Supported values: USD,ARS,EUR,MXN,COP,PEN,CLP,AUD,UYU,BOB,PYG,BRL,INR,GTQ,HNL. |
lang | language. | no | no | object | You may find all available values at ISO 639-1 |
type | type of content. | no | yes | string | 'physical' |
table_of_contents | The publication's table of contents. Can be JSON for electronic publications or HTML for physical publications. | no | no | json,html | |
pages | Quantity of pages | no | no | integer | It is used only when type=physical. |
height | This field indicates the vertical dimension of the physical content in specific units (e.g., centimeters or inches). | no | no | integer | It is used only when type=physical. |
width | This field indicates the horizontal dimension of the physical product in specific units (e.g., centimeters or inches). | no | no | integer | It is used only when type=physical. |
weight | This field indicates the vertical dimension of the physical product in specific units (e.g., centimeters or inches). | no | no | integer | It is used only when type=physical. |
stock | Quantity available for sale. | no | no | integer | It is used only when type=physical. |
preorder_from | Ignite anticipation by specifying the start date for preorders. | no | no | datetime | YYYY-MM-DD HH:MM:SS e.g. '2021-09-12 12:00:00' |
sale_from | Trigger excitement by indicating the start date for sales. | no | no | datetime | YYYY-MM-DD HH:MM:SS e.g. '2021-09-15 12:00:00' |
::: tip When updating a publication, make sure to send all the desired final taxonomies and terms. If a publication already has a term in a specific taxonomy and you just want to add a second one, you still need to send both. :::
{
"publication_date": "2020-06-01",
"name": "The Computing Machine",
"description": "The description of the publication...",
"free": 0,
"bisac": [{ "code": "ANT018000" }],
"collection": ["The classics"],
"author": ["Grace Hopper", "Alan Turing"],
"country": ["Finland"],
"category": ["Hardware meets software"],
"publisher": ["publica.la"],
"keyword": ["API", "book"],
"prices": {
"USD": 2.00,
"ARS": 0.02,
"EUR": 2.35,
"MXN": 0.10,
"COP": 0.00,
"PEN": 0.51,
"CLP": 0.00,
"AUD": 1.47,
"UYU": 0.05,
"BOB": 0.29,
"PYG": 0.00,
"BRL": 0.38,
"INR": 0.03,
"GTQ": 0.26,
"HNL": 0.08
}
}
warning
The file and file type cannot be updated. If this action is necessary, you can replace the file with another file of the same type from the store publication panel.
Response
Code | Description |
---|---|
204 | Object Updated |
422 | Validation error, the reason of the error will be described in the response body |
401 | Unauthenticated |
Delete
DELETE /integration-api/v1/dashboard/issues/{issue_id}
DELETE /integration-api/v1/dashboard/issues/{external_id}
Example 1: https://your-store.com/integration-api/v1/dashboard/issues/468166
Example 2: https://your-store.com/integration-api/v1/dashboard/issues/9781496822482
Responses
Code | Description |
---|---|
200 | Success |
404 | Object not found |
401 | Unauthenticated |